// ======================================================================================
// Copyright(C) 2018 FI Ltd. All rights reserved.
//
// SYSTEM NAME     : FI.Net Application Framework
// COMPONENT ID    : FI.Helpers.Data.Configuration.ParameterData
// COMPONENT DESC  : Configuration settings for parameter
//
// CREATED DATE/BY : 18 Aug 2018 / Tian Mi
//
// REVISION HISTORY:DATE/BY          SR#/CS/PM#/OTHERS      DESCRIPTION OF CHANGE
// =========================================================================================

using System.ComponentModel;
using System.Configuration;
using FI.Core.Configuration;

namespace FI.Helpers.Data.Configuration
{
    /// <summary>    
    /// Configuration settings for default stored procedure format.
    /// </summary>
    public class ParameterData : NamedConfigurationElement
    {
        private const string FormatProperty = "format";

        /// <summary>
        /// The parameter format mapping to the current version of data row
        /// </summary>
        public const string Current         = "Current";

        /// <summary>
        /// The parameter format mapping to the original version of data row
        /// </summary>
        public const string Original        = "Original";

        /// <summary>
        /// Gets the format of parameter.
        /// </summary>
        /// <value>The format.</value>
        [ConfigurationProperty(FormatProperty, IsRequired = true)]
        public string Format
        {
            get { return (string)base[FormatProperty]; }
            set { base[FormatProperty] = value; }
        }
    }
}